This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/daf-patient
Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.
This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Patient.
Summary
Mandatory: 3 elements (+8 nested mandatory elements)
Must-Support: 41 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Patient.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-race Binding: MU Race Value Set (required) |
us-core-ethnicity | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity Binding: Ethnicity group (required) |
us-core-religion | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-religion Binding: v3 Code System ReligiousAffiliation (extensible) |
patient-mothersMaidenName | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
birthPlace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S ∑ | 1..* | Identifier | An identifier for this patient |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! ∑ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | S ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | The value that is unique within the system. Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?! S∑ | 0..1 | boolean | Whether this patient's record is in active use |
name | S ∑ | 0..* | HumanName | A name associated with the patient |
telecom | S ∑ | 0..* | ContactPoint | A contact detail for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
value | S ∑ | 1..1 | string | The actual contact point details |
use | ?! S∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
gender | S ∑ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | S ∑ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?! S∑ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | S ∑ | 0..* | Address | Addresses for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | S ∑ | 1..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | S ∑ | 1..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | S ∑ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | S ∑I | 1..1 | string | Postal code for area inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
country | S ∑ | 1..1 | string | Country (can be ISO 3166 3 letter code) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required) |
multipleBirth[x] | S | 0..1 | boolean, integer | Whether patient is part of a multiple birth |
photo | 0..* | Attachment | Image of the patient | |
contact | S I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
relationship | S | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (required) |
name | S | 0..1 | HumanName | A name associated with the contact person |
telecom | S | 0..* | ContactPoint | A contact detail for the person |
address | S | 0..1 | Address | Address for the contact person |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | S ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | S ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | S ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | S ∑I | 0..1 | string | Postal code for area inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
country | S ∑ | 0..1 | string | ISO 3166 2 or 3 letter Country Code Binding: ISO Country Codes (required) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: IETF BCP-47 (required) |
preferred | 0..1 | boolean | Language preference indicator | |
careProvider | S | 0..* | Reference(DAF-Organization | DAF-Pract) | Patient's nominated primary care provider |
managingOrganization | S ∑ | 0..1 | Reference(DAF-Organization) | Organization that is the custodian of the patient record |
link | ?! | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
other | ?! | 1..1 | Reference(Patient) | The other patient resource that the link refers to |
type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
Documentation for this format |
todo
This structure is derived from Patient.
Summary
Mandatory: 3 elements (+8 nested mandatory elements)
Must-Support: 41 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Patient.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-race Binding: MU Race Value Set (required) |
us-core-ethnicity | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity Binding: Ethnicity group (required) |
us-core-religion | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-religion Binding: v3 Code System ReligiousAffiliation (extensible) |
patient-mothersMaidenName | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
birthPlace | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S ∑ | 1..* | Identifier | An identifier for this patient |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! ∑ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | S ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | S ∑ | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | S ∑ | 1..1 | string | The value that is unique within the system. Example: 123456 |
period | ∑ | 0..1 | Period | Time period when id is/was valid for use |
assigner | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?! S∑ | 0..1 | boolean | Whether this patient's record is in active use |
name | S ∑ | 0..* | HumanName | A name associated with the patient |
telecom | S ∑ | 0..* | ContactPoint | A contact detail for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
value | S ∑ | 1..1 | string | The actual contact point details |
use | ?! S∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
gender | S ∑ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | S ∑ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?! S∑ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | S ∑ | 0..* | Address | Addresses for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | S ∑ | 1..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | S ∑ | 1..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | S ∑ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | S ∑I | 1..1 | string | Postal code for area inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
country | S ∑ | 1..1 | string | Country (can be ISO 3166 3 letter code) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required) |
multipleBirth[x] | S | 0..1 | boolean, integer | Whether patient is part of a multiple birth |
photo | 0..* | Attachment | Image of the patient | |
contact | S I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
relationship | S | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (required) |
name | S | 0..1 | HumanName | A name associated with the contact person |
telecom | S | 0..* | ContactPoint | A contact detail for the person |
address | S | 0..1 | Address | Address for the contact person |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
line | S ∑ | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
city | S ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon |
district | ∑ | 0..1 | string | District name (aka county) Example: Madison |
state | S ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | S ∑I | 0..1 | string | Postal code for area inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
country | S ∑ | 0..1 | string | ISO 3166 2 or 3 letter Country Code Binding: ISO Country Codes (required) |
period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: IETF BCP-47 (required) |
preferred | 0..1 | boolean | Language preference indicator | |
careProvider | S | 0..* | Reference(DAF-Organization | DAF-Pract) | Patient's nominated primary care provider |
managingOrganization | S ∑ | 0..1 | Reference(DAF-Organization) | Organization that is the custodian of the patient record |
link | ?! | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
other | ?! | 1..1 | Reference(Patient) | The other patient resource that the link refers to |
type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Patient.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/us-core-race]] | MU Race Value Set | required | MU Race Value Set |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/us-core-ethnicity]] | Ethnicity group | required | Ethnicity group |
Patient.extension [UriType[http://hl7.org/fhir/StructureDefinition/us-core-religion]] | v3 Code System ReligiousAffiliation | extensible | v3 Code System ReligiousAffiliation |
Patient.identifier.use | IdentifierUse | required | IdentifierUse |
Patient.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
Patient.telecom.system | ContactPointSystem | required | ContactPointSystem |
Patient.telecom.use | ContactPointUse | required | ContactPointUse |
Patient.gender | AdministrativeGender | required | AdministrativeGender |
Patient.address.use | AddressUse | required | AddressUse |
Patient.address.type | AddressType | required | AddressType |
Patient.address.state | USPS Two Letter Alphabetic Codes | required | USPS Two Letter Alphabetic Codes |
Patient.maritalStatus | Marital Status Codes | required | Marital Status Codes |
Patient.contact.relationship | PatientContactRelationship | required | PatientContactRelationship |
Patient.contact.address.use | AddressUse | required | AddressUse |
Patient.contact.address.type | AddressType | required | AddressType |
Patient.contact.address.state | USPS Two Letter Alphabetic Codes | required | USPS Two Letter Alphabetic Codes |
Patient.contact.address.country | ?ext | required | http://www.iso.org/iso/country_codes.htm |
Patient.contact.gender | AdministrativeGender | required | AdministrativeGender |
Patient.animal.species | AnimalSpecies | example | AnimalSpecies |
Patient.animal.breed | AnimalBreeds | example | AnimalBreeds |
Patient.animal.genderStatus | GenderStatus | example | GenderStatus |
Patient.communication.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Patient.link.type | LinkType | required | LinkType |
Id | Path | Details | Requirements |
inv-1 | Patient.address.postalCode | (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} ) | |
pat-1 | Patient.contact | SHALL at least contain a contact's details or a reference to an organization XPath: f:name or f:telecom or f:address or f:organization | |
inv-2 | Patient.contact.address.postalCode | (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} ) |